<!-- HTML header for doxygen 1.8.13-->
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.13"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>MTB CAT1 Peripheral driver library: Functions</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtreedata.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript">
  $(document).ready(initResizable);
</script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<link href="doxygen_style.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  <td id="projectlogo"><a href="http://www.cypress.com/"><img alt="Logo" src="IFXCYP_one-line.png"/></a></td>
  <td id="projectalign" style="padding-left: 0.5em;">
   <div id="projectname">MTB CAT1 Peripheral driver library</div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.13 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
$(function() {
  initMenu('',true,false,'search.php','Search');
  $(document).ready(function() { init_search(); });
});
</script>
<div id="main-nav"></div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
  <div id="nav-tree">
    <div id="nav-tree-contents">
      <div id="nav-sync" class="sync"></div>
    </div>
  </div>
  <div id="splitbar" style="-moz-user-select:none;" 
       class="ui-resizable-handle">
  </div>
</div>
<script type="text/javascript">
$(document).ready(function(){initNavTree('group__group__sysclk__alt__hf__funcs.html','');});
</script>
<div id="doc-content">
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
     onmouseover="return searchBox.OnSearchSelectShow()"
     onmouseout="return searchBox.OnSearchSelectHide()"
     onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>

<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0" 
        name="MSearchResults" id="MSearchResults">
</iframe>
</div>

<div class="header">
  <div class="summary">
<a href="#func-members">Functions</a>  </div>
  <div class="headertitle">
<div class="title">Functions<div class="ingroups"><a class="el" href="group__group__sysclk.html">SysClk       (System Clock)</a> &raquo; <a class="el" href="group__group__sysclk__alt__hf.html">Alternative High-Frequency Clock</a></div></div>  </div>
</div><!--header-->
<div class="contents">
<a name="details" id="details"></a><h2 class="groupheader">General Description</h2>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:gaf948bdd0d4b0fbf2774642db55eea712"><td class="memItemLeft" align="right" valign="top">uint32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__group__sysclk__alt__hf__funcs.html#gaf948bdd0d4b0fbf2774642db55eea712">Cy_SysClk_AltHfGetFrequency</a> (void)</td></tr>
<tr class="memdesc:gaf948bdd0d4b0fbf2774642db55eea712"><td class="mdescLeft">&#160;</td><td class="mdescRight">Reports the frequency of the Alternative High-Frequency Clock.  <a href="#gaf948bdd0d4b0fbf2774642db55eea712">More...</a><br /></td></tr>
<tr class="separator:gaf948bdd0d4b0fbf2774642db55eea712"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gabc0dc28ac55e3606f2666742a8553962"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__group__sysclk__returns.html#gad6699a184e2e3c01433251b0981558f3">cy_en_sysclk_status_t</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__group__sysclk__alt__hf__funcs.html#gabc0dc28ac55e3606f2666742a8553962">Cy_SysClk_AltHfEnable</a> (uint32_t timeoutus)</td></tr>
<tr class="memdesc:gabc0dc28ac55e3606f2666742a8553962"><td class="mdescLeft">&#160;</td><td class="mdescRight">Enables the ATLHF.  <a href="#gabc0dc28ac55e3606f2666742a8553962">More...</a><br /></td></tr>
<tr class="separator:gabc0dc28ac55e3606f2666742a8553962"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gaaa7e7850d3f5674f78d51e99dd3a2d4a"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__group__sysclk__alt__hf__funcs.html#gaaa7e7850d3f5674f78d51e99dd3a2d4a">Cy_SysClk_IsAltHfEnabled</a> (void)</td></tr>
<tr class="memdesc:gaaa7e7850d3f5674f78d51e99dd3a2d4a"><td class="mdescLeft">&#160;</td><td class="mdescRight">Reports if ALTHF is enabled or not.  <a href="#gaaa7e7850d3f5674f78d51e99dd3a2d4a">More...</a><br /></td></tr>
<tr class="separator:gaaa7e7850d3f5674f78d51e99dd3a2d4a"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<h2 class="groupheader">Function Documentation</h2>
<a id="gaf948bdd0d4b0fbf2774642db55eea712"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gaf948bdd0d4b0fbf2774642db55eea712">&#9670;&nbsp;</a></span>Cy_SysClk_AltHfGetFrequency()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">uint32_t Cy_SysClk_AltHfGetFrequency </td>
          <td>(</td>
          <td class="paramtype">void&#160;</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Reports the frequency of the Alternative High-Frequency Clock. </p>
<dl class="section note"><dt>Note</dt><dd>This API is available for CAT1A (excluding TVIIBE) and CAT1B devices.</dd></dl>
<dl class="section user"><dt>Function Usage</dt><dd><div class="fragment"><div class="line">    <span class="comment">/* BLE ECO configuration: ECO Frequency: 32 MHZ, Divider: 2 */</span></div><div class="line">    <span class="comment">/* Start-up time(uS): 1500, Load cap(pF): 9.9 */</span></div><div class="line">    </div><div class="line">    uint32_t startTime = (uint32_t)(1500 / 31.25);</div><div class="line">    uint32_t loadCap   = (uint32_t)((9.9 - 7.5) / 0.075);</div><div class="line">    </div><div class="line">    <span class="comment">/* Configure the BLE ECO clock */</span></div><div class="line">    (void) <a class="code" href="group__group__ble__clk__functions.html#gae92f61cd532c63d9547c52ccd6757ff7">Cy_BLE_EcoConfigure</a>(<a class="code" href="group__group__ble__clk__data__type.html#gga90f34ffaefcfb39107f8f60a2a910b10ab18e06510cdcdff510803020cadaed89">CY_BLE_BLESS_ECO_FREQ_32MHZ</a>, <a class="code" href="group__group__ble__clk__data__type.html#ggaa50dfcc9b2d385a197421f2262e462ffadc32f9a281d44abf83fab992d183fd9b">CY_BLE_SYS_ECO_CLK_DIV_2</a>, loadCap, startTime, <a class="code" href="group__group__ble__clk__data__type.html#gga0b65a546765caf85918c9f06e66d25fbabf04e7c9f17091dcbaecd4c80978d021">CY_BLE_ECO_VOLTAGE_REG_AUTO</a>);</div><div class="line">    </div><div class="line">    <span class="comment">/* In case if there is a need to get the BLE ECO frequency */</span></div><div class="line">    uint32_t bleEcoFreq = <a class="code" href="group__group__sysclk__alt__hf__funcs.html#gaf948bdd0d4b0fbf2774642db55eea712">Cy_SysClk_AltHfGetFrequency</a>();</div></div><!-- fragment --></dd></dl>

</div>
</div>
<a id="gabc0dc28ac55e3606f2666742a8553962"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gabc0dc28ac55e3606f2666742a8553962">&#9670;&nbsp;</a></span>Cy_SysClk_AltHfEnable()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="group__group__sysclk__returns.html#gad6699a184e2e3c01433251b0981558f3">cy_en_sysclk_status_t</a> Cy_SysClk_AltHfEnable </td>
          <td>(</td>
          <td class="paramtype">uint32_t&#160;</td>
          <td class="paramname"><em>timeoutus</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Enables the ATLHF. </p>
<dl class="section note"><dt>Note</dt><dd>This API is available for CAT1B devices.</dd></dl>
<dl class="section return"><dt>Returns</dt><dd>Error / status code: <br />
CY_SYSCLK_SUCCESS - ALTHF successfully disabled <br />
CY_SYSCLK_TIMEOUT - ALTHF enabling failed due to timeout </dd></dl>

</div>
</div>
<a id="gaaa7e7850d3f5674f78d51e99dd3a2d4a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gaaa7e7850d3f5674f78d51e99dd3a2d4a">&#9670;&nbsp;</a></span>Cy_SysClk_IsAltHfEnabled()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">bool Cy_SysClk_IsAltHfEnabled </td>
          <td>(</td>
          <td class="paramtype">void&#160;</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Reports if ALTHF is enabled or not. </p>
<dl class="section note"><dt>Note</dt><dd>This API is available for CAT1B devices.</dd></dl>
<dl class="section return"><dt>Returns</dt><dd>Status of ALTHF <br />
true = Enabled <br />
false = Not Enabled </dd></dl>

</div>
</div>
</div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part
<div id="nav-path" class="navpath">
    <ul>
        <li class="footer">
            Generated for <b>MTB CAT1 Peripheral driver library</b> by <b>Cypress Semiconductor Corporation</b>.
            All rights reserved.
        </li>
    </ul>
</div>
-->
</body>
</html>
